Place API
Methods and endpoints
The Place API allows you to:
- search addresses to find your customer’s exact location
- obtain relevant network information associated with a location
- view active and open products as well as ONTs (intact and active) at a location.
The Place API includes the following methods and endpoints:
| Endpoint | Method and endpoint | Function |
|---|---|---|
| API asset version | GET /version | Retrieve API asset full version number (major, minor and patch version numbers). |
| Places By Query | GET /places | Retrieve a list of matching addresses (Places) off supplied address data or PLSAM ID or TUI ID or Product ONT Serial Number. |
| Place by ID | GET /places/{placeId} | Retrieve matching address/location (Place) information of supplied Place ID information. |
| Site Information By Place ID | GET /places/{placeId}/siteInformation | Retrieve matching address/location (Place) information of supplied Place ID information. |
Mandatory attributes
These attributes are mandatory for the Place API:
| Attribute | Description |
|---|---|
| streetName | Used as part of GET /places endpoint.Note: If no key-based query parameter is supplied, then a street name must be supplied when requesting a search. |
| tuiId samId productId ontSerialNumber | Used as part of GET /places endpoint.Note: If no street name is supplied, then a key-based query parameter must be supplied when requesting a search. Key-based parameters include: (TUI ID, PLSAM ID, Product ID, or ONT Serial Number). |
Note: For more information on all available resources, attributes, parameters, field types, length and other restrictions, see the API Specification.